<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK IT ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006-2016 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: yunwuxin <448901948@qq.com>
// +----------------------------------------------------------------------
declare (strict_types = 1); //声明代码的执行指令为开启严格模式,主要为参数类型为严格模式,方便常驻内存

namespace think\exception;

use Exception;
use think\App;
use think\console\Output;
use think\db\exception\DataNotFoundException;
use think\db\exception\ModelNotFoundException;
use think\Request;
use think\Response;
use Throwable;


// +----------------------------------------------------------------------
// | 所属:系统核心类
// | (愿景,目的) 名称:系统异常处理类
// | 功能: 统一异常的信息输出格式,主要对 2 种,http+cli.
// | (心智)原则: 单一职责原则/里氏替换原则/依赖倒置原则/接口隔离原则/迪米特法则/开闭原则
// | 结构组成: 
// | (形式) 类模式: 
// | (模式)模式类型:  创造类
// | (模式)设计模式:  单例
// | 产生事件:
// | Understand:Cluster | Cluster Call Butterfly
// |
// | ---------分析--------------
// | 需求的产生 想法
// | 道: <用户-客户立场>|<人的视角>(欲望)
// | 愿景:  
// | 目的:  
// |
// | =============================
// | 需求的分解--架构-偏商业架构/业务角度
// | 制定设置规则的原则
// | 法: <组织内部立场>|<人的视角>
// | 如何适应新的应用场景
// | 适用场景:
// | 目的: 
// | 心智:遵循思维模式,原则
// | 结构:
// | 协议: 
// |
// | =============================
// | 术:<组织内部立场>|<物的视角>
// | 用户/客户立场:(人的视角)(结果)感知
// | 形式:定义了整个项目的文件目录形式,各目录文件功能
// |
// | 组织内部立场:(物的视角)(设定)系统思考.逻辑思考
// | 结构:
// |
// | 协议:
// |
// | =============================
// | 方案实施 执行 怎么用
// | 器:<物的视角>
// | 对什么场景下的哪个业务节点.有什么资源方法和模式可用
// | (转换接口,把物和人联系起来)
// | 形式:
// |
// | (用户/客户立场|视角|(背后是结构)
// | 模式:
// |
// | (具体方法)
// | 事件:
// | -------------------------
// |
// | 知识点: 
// | 继承类说明: 
// | 点评:  
// |  理解的层级:器,知道本类大概的作用,都做了些什么.但为什么做.还有哪些问题.可改进的地方,不清楚.
// |           本类不同的方法使用的原则不同,但可以按作用边界来区分.是单一原则
// |           对于方法之间的调用原则,并不清楚
// |
// +----------------------------------------------------------------------

/**
 * 系统异常处理类
 */
class Handle
{
    /** @var App */
    protected $app;

    /**
     * 忽略类
     * @var array
     */
    protected $ignoreReport = [
        HttpException::class,
        HttpResponseException::class,
        ModelNotFoundException::class,
        DataNotFoundException::class,
        ValidateException::class,
    ];

    /**
     * 是否是 json 协议
     * @var bool
     */
    protected $isJson = false;

    /**
     * 架构方法
     *
     * @access public
     * @param App $app 容器对象
     */
    public function __construct(App $app)
    {
        $this->app = $app;
    }

    /**
     * Report or log an exception.
     * 报告或记录异常
     * @depreacate 作用:这个方法是给日志用的,本方法负责写日志
     * @todo 一个特殊的方法,好像是给控制台用的,我也不清楚类似convertExceptionToArray方法,都是收集错误信息进行清洗统一输出格式
     *
     * @access public
     * @param Throwable $exception
     * @return void
     */
    public function report(Throwable $exception): void
    {
        if (!$this->isIgnoreReport($exception)) {
            // 收集异常数据
            if ($this->app->isDebug()) {
                $data = [
                    'file'    => $exception->getFile(), //错误文件
                    'line'    => $exception->getLine(), //错误行
                    'message' => $this->getMessage($exception), //获取错误信息
                    'code'    => $this->getCode($exception), //获取错误编码
                ];
                $log = "[{$data['code']}]{$data['message']}[{$data['file']}:{$data['line']}]";
            } else {
                $data = [
                    'code'    => $this->getCode($exception), //获取错误编码
                    'message' => $this->getMessage($exception), //获取错误信息
                ];
                $log = "[{$data['code']}]{$data['message']}";
            }

            if ($this->app->config->get('log.record_trace')) {
                $log .= PHP_EOL . $exception->getTraceAsString();
            }

            try {
                $this->app->log->record($log, 'error');
            } catch (Exception $e){
                // 此处存在空的catch代码块问题
                // link: http://www.iyuji.cn/iyuji/s/YjFLb3JuVVltWEpFdzlTSndBcHFjQT09/1588404098629432
                //
            }
        }
    }

    /**
     * 忽略的错误报告
     *
     * @access protected
     * @param Throwable $exception
     * @return void
     */
    protected function isIgnoreReport(Throwable $exception): bool
    {
        foreach ($this->ignoreReport as $class) {
            if ($exception instanceof $class) {
                return true;
            }
        }

        return false;
    }

    /**
     * Render an exception into an HTTP response.
     * 使用http响应异常
     * @depreacate 星级:****
     * @todo 异常响应的核心方法,根本异常的不同类型分别输出不同类型的错误响应
     *
     * @access public
     * @param Request   $request
     * @param Throwable $e
     * @return Response
     */
    public function render($request, Throwable $e): Response
    {
        $this->isJson = $request->isJson();
        if ($e instanceof HttpResponseException) {
            // 调用HttpResponseException的HTTP响应异常
            return $e->getResponse();
        } elseif ($e instanceof HttpException) {
            // 跳转HTTP响应 异常响应
            return $this->renderHttpException($e);
        }  else {
            // 输出转换后的错误响应
            if(false !== strpos(PHP_SAPI, 'cli')){
                // 对http的 cli.直接退出,不进行后续处理.避免麻烦.但这不规范
                exit;
            }else{
                return $this->convertExceptionToResponse($e);
            }

        }
    }

    /**
     * 使用控制台响应异常
     * @depreacate 星级:**
     * @todo 这个方法是本类中特异的类.主要为其它类调用的.和本类中关联不大,但都是负责异常信息输出,
     *      但要注意,这个类,会调用控制台的输出,这个类,放这个地方,其实是为了单一原则,但这个地方和控制台耦合的很紧.可以拆分
     *
     * @access public
     * @param Output    $output
     * @param Throwable $e
     */
    public function renderForConsole(Output $output, Throwable $e): void
    {
        if ($this->app->isDebug()) {
            $output->setVerbosity(Output::VERBOSITY_DEBUG);
        }

        $output->renderException($e);
    }


    //============下面的方法都为上面的方法服务,可以认为是解耦出来的子方法============

    /**
     * 跳转HTTP响应 异常响应
     *
     * @access protected
     * @param HttpException $e
     * @return Response
     */
    protected function renderHttpException(HttpException $e): Response
    {
        $status   = $e->getStatusCode();
        // 自定义异常处理的http 处理模板
        $template = $this->app->config->get('app.http_exception_template');

        // 非调试状态并且自定义模板为存在的情况下
        if (!$this->app->isDebug() && !empty($template[$status])) {
            return Response::create($template[$status], 'view', $status)->assign(['e' => $e]);
        } else {
            // 输出转换后的错误响应
            if(false !== strpos(PHP_SAPI, 'cli')){
                // 对http的 cli 异常调用控制台错误处理
                return $this->renderForConsole(new Output, $e);
            }else{
                return $this->convertExceptionToResponse($e);
            }
        }
    }

    /**
     * 收集异常数据
     * @depreacate 星级:*****
     * @todo 把错误转换为数组供显示
     *
     * @param Throwable $exception
     * @return array
     */
    protected function convertExceptionToArray(Throwable $exception): array
    {
        if ($this->app->isDebug()) {
            // 调试模式，获取详细的错误信息
            $traces        = [];
            $nextException = $exception;
            do {
                $traces[] = [
                    'name'    => get_class($nextException), //获取类名
                    'file'    => $nextException->getFile(), //文件位置
                    'line'    => $nextException->getLine(), //出错行
                    'code'    => $this->getCode($nextException), //获取错误编码
                    'message' => $this->getMessage($nextException), //获取错误信息
                    'trace'   => $nextException->getTrace(), //调用链
                    'source'  => $this->getSourceCode($nextException), //获取出错文件内容的摘要信息
                ];
            } while ($nextException = $nextException->getPrevious());
            $data = [
                'code'    => $this->getCode($exception), //获取错误编码
                'message' => $this->getMessage($exception), //获取错误信息
                'traces'  => $traces,
                'datas'   => $this->getExtendData($exception), //获取异常扩展信息
                'tables'  => [
                    'GET Data'            => $this->app->request->get(),
                    'POST Data'           => $this->app->request->post(),
                    'Files'               => $this->app->request->file(),
                    'Cookies'             => $this->app->request->cookie(),
                    'Session'             => $this->app->exists('session') ? $this->app->session->all() : [],
                    'Server/Request Data' => $this->app->request->server(),
                ],
            ];
        } else {
            // 部署模式仅显示 Code 和 Message
            $data = [
                'code'    => $this->getCode($exception), //获取错误编码
                'message' => $this->getMessage($exception), //获取错误信息
            ];

            if (!$this->app->config->get('app.show_error_msg')) {
                // 不显示详细错误信息
                $data['message'] = $this->app->config->get('app.error_message');
            }
        }

        return $data;
    }

    /**
     * 输出转换后的错误响应
     * @depreacate 星级:***
     * @todo 采集错误信息类型进行清洗,统一格式进行输出
     *
     * @access protected
     * @param Throwable $exception
     * @return Response
     */
    protected function convertExceptionToResponse(Throwable $exception): Response
    {

        // 判断响应格式
        if (!$this->isJson) {
            // 跳转到异常结构页面
            $response = Response::create($this->renderExceptionContent($exception));
        } else {
            // 收集异常数据
            $response = Response::create($this->convertExceptionToArray($exception), 'json');
        }

        // 确定一个 PHP 变量是否属于某一类
	// 获取协议头.错误码和其它信息
        if ($exception instanceof HttpException) {
            $statusCode = $exception->getStatusCode();
            $response->header($exception->getHeaders());
        }

        return $response->code($statusCode ?? 500);
    }

    /**
     * 跳转到异常结构页面
     * @depreacate 星级:***
     * @todo 在 http 下显示错误非常重要,本方法把错误通过模板加载后渲染结果输出
     *
     * @access protected
     * @param Throwable $exception
     * @return string                错误结构页面
     */
    protected function renderExceptionContent(Throwable $exception): string
    {
        // 锁定缓冲区,进行渲染输出
        ob_start();
        // 加载收集异常数据
        $data = $this->convertExceptionToArray($exception);
        // 从数组中将变量导入到当前的符号表,其实就是出错的数据加载到当前的符合表,方便模板渲染时获取变量
        // 此处存在全局变量覆盖问题
        // link: http://www.iyuji.cn/iyuji/s/YjFLb3JuVVltWEpFdzlTSndBcHFjQT09/1588435516005148
        // 内部异常输出,可以忽略
        extract($data);
        include $this->app->config->get('app.exception_tmpl') ?: __DIR__ . '/../../tpl/think_exception.tpl';


        return ob_get_clean();
    }

    /**
     * 获取错误编码
     * ErrorException则使用错误级别作为错误编码
     * @todo 从系统异常类中取对应方法数据
     *
     * @access protected
     * @param Throwable $exception
     * @return integer                错误编码
     */
    protected function getCode(Throwable $exception)
    {
        $code = $exception->getCode();

        if (!$code && $exception instanceof ErrorException) {
            $code = $exception->getSeverity();
        }

        return $code;
    }

    /**
     * 获取错误信息
     * ErrorException则使用错误级别作为错误编码
     * @depreacate 星级:*****
     * @todo 非常重要的方法,系统里出错有关的地方,会调用此方法
     *
     * @access protected
     * @param Throwable $exception
     * @return string                错误信息
     */
    protected function getMessage(Throwable $exception): string
    {
        $message = $exception->getMessage();

        // 是否运行在命令行下
        if ($this->app->runningInConsole()) {
            return $message;
        }

        $lang = $this->app->lang;

        if (strpos($message, ':')) {
            $name    = strstr($message, ':', true);
            $message = $lang->has($name) ? $lang->get($name) . strstr($message, ':') : $message;
        } elseif (strpos($message, ',')) {
            $name    = strstr($message, ',', true);
            $message = $lang->has($name) ? $lang->get($name) . ':' . substr(strstr($message, ','), 1) : $message;
        } elseif ($lang->has($message)) {
            $message = $lang->get($message);
        }

        return $message;
    }

    /**
     * 获取出错文件内容
     * 获取错误的前9行和后9行
     *
     * @access protected
     * @param Throwable $exception
     * @return array                 错误文件内容
     */
    protected function getSourceCode(Throwable $exception): array
    {
        // 读取前9行和后9行
        $line  = $exception->getLine();
        $first = ($line - 9 > 0) ? $line - 9 : 1;

        try {
            $contents = file($exception->getFile()) ?: [];
            $source   = [
                'first'  => $first,
                'source' => array_slice($contents, $first - 1, 19),
            ];
        } catch (Exception $e) {
            $source = [];
        }

        return $source;
    }

    /**
     * 获取异常扩展信息
     * 用于非调试模式html返回类型显示
     *
     * @access protected
     * @param Throwable $exception
     * @return array                 异常类定义的扩展数据
     */
    protected function getExtendData(Throwable $exception): array
    {
        $data = [];

        // 异常基础类
        if ($exception instanceof \think\Exception) {
            $data = $exception->getData();
        }

        return $data;
    }

    /**
     * 获取常量列表
     *
     * @access protected
     * @return array 常量列表
     */
    protected function getConst(): array
    {
        // 返回所有常量的关联数组，键是常量名，值是常量值
        $const = get_defined_constants(true);

        return $const['user'] ?? [];
    }
}
